/**

This file is part of MaCI/GIMnet.

MaCI/GIMnet is free software: you can redistribute it and/or modify it 
under the terms of the GNU Lesser General Public License as published 
by the Free Software Foundation, either version 3 of the License, or 
(at your option) any later version.

MaCI/GIMnet is distributed in the hope that it will be useful, but WITHOUT 
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public 
License for more details.

You should have received a copy of the GNU Lesser General Public 
License along with GIMnet. (See COPYING.LESSER) If not, see 
<http://www.gnu.org/licenses/>.

**/
// -*- coding:iso-8859-15 mode: c++ -*-
/** 
 * \file
 * \brief PlayerModule upper class header.
 * \author Matthieu Myrsky <matthieu.myrsky@tkk.fi>
 *
 * $Id: PlayerModule.hpp,v 1.4 2009-06-05 14:15:45 morsko Exp $
 *
 */
#ifndef _PLAYERMODULE_HPP_
#define _PLAYERMODULE_HPP_
#include <string>
#include "timestamp.hpp"
#include <list>
class PlayerModule{
public:
  
  /**
   * Constructor
   * 
   */
  PlayerModule();
  

  /**
   * Destructor
   */
  virtual ~PlayerModule();

  /**
   * Returns list of times when player module want to be informed. Basically all the times 
   * when data has to be sent.
   *
   * @param aTimes[out] List of timestamp when module has some activity
   * 
   */
  virtual bool GetTimes(std::list<gim::time> *aTimes) = 0;

  /**
   * Return begin and end times of the module
   *
   * @param aBegin Begin time
   * @param aEnd   End time
   */
  virtual void GetTimeLimits(gim::time &aBegin,gim::time &aEnd) = 0;

  /**
   * Function which is called by Player for informing the current time
   * 
   * @param[in] aTime Time of action
   */
  virtual bool OnTime(gim::time aTime) = 0;

  /**
   * Returns the name of the instance. E.g MaCI_Interface.InstanceName
   */
  virtual std::string GetName(void) = 0;


};
#endif
